<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Human readable report format</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../index.html" title="Boost.Test">
<link rel="up" href="../report_formats.html" title="Report formats">
<link rel="prev" href="../report_formats.html" title="Report formats">
<link rel="next" href="report_xml_format.html" title="XML based report output format">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../report_formats.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../report_formats.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="report_xml_format.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_test.test_output.report_formats.report_human_readable_format"></a><a name="ref_report_formats"></a><a class="link" href="report_human_readable_format.html" title="Human readable report format">Human
        readable report format</a>
</h4></div></div></div>
<p>
          The human readable report format is designed to produce the most human
          friendly description of the results of a test module testing. This is a
          default format generated by test modules.
        </p>
<p>
          Depending on the framework's report level the output looks like this:
        </p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Level
                  </p>
                </th>
<th>
                  <p>
                    Output
                  </p>
                </th>
</tr></thead>
<tbody>
<tr>
<td>
                  <p>
                    no report
                  </p>
                </td>
<td>
                  <p>
                    On this level the framework does not produce result report at
                    all. It make sense to use this level for test modules running
                    unattended (as part of some automated regression testing system,
                    for example)
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    Confirmation
                  </p>
                </td>
<td>
                  <div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">Passing test</span></dt>
<dd><p>
                          *** No errors detected
                        </p></dd>
<dt><span class="term">Skipped test</span></dt>
<dd><p>
                          *** The test suite &lt;name&gt; was skipped; see standard
                          output for details
                        </p></dd>
<dt><span class="term">Aborted test</span></dt>
<dd><p>
                          *** The test suite &lt;name&gt; was aborted; see standard
                          output for details
                        </p></dd>
<dt><span class="term">Failed test without failed assertions</span></dt>
<dd><p>
                          *** Errors were detected in the test suite &lt;name&gt;;
                          see standard output for details
                        </p></dd>
<dt><span class="term">Failed test</span></dt>
<dd><p>
                          *** N failures are detected in test suite &lt;name&gt;
                        </p></dd>
<dt><span class="term">Failed test with some failures expected</span></dt>
<dd><p>
                          *** N failures are detected (M failures are expected) in
                          test suite &lt;name&gt;
                        </p></dd>
</dl>
</div>
                </td>
</tr>
<tr>
<td>
                  <p>
                    Detailed
                  </p>
                </td>
<td>
                  <p>
                    On this level we report result for each test units hierarchically
                    (each test unit is reported as part of parent test unit report.
                    Test cases are reported like this:
                  </p>
<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">        Test case/suite &lt;name&gt; has passed/was skipped/was aborted/has failed/ with:
            N assertions out of M passed
            N assertions out of M failed
            N warnings out of M failed
            X failures expected
        </pre>
                  <p>
                    Only relevant lines will appear. If test case does not have failing
                    assertions corresponding line in the report is not shown.
                  </p>
                  <p>
                    Test suite in addition to above lines also report these:
                  </p>
<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">            N test cases out of M passed
            N test cases out of M passed with warnings
            N test cases out of M failed
            N test cases out of M skipped
            N test cases out of M aborted
            </pre>
                  <p>
                    And similarly to above lines only relevant ones will appear in
                    output.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    Short
                  </p>
                </td>
<td>
                  <p>
                    Short report format is similar to detailed, but only reports
                    information for master test suite
                  </p>
                </td>
</tr>
</tbody>
</table></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2001-2022 Boost.Test contributors<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../report_formats.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../report_formats.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="report_xml_format.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
